Skip to main content

<internal>

Index

Classes

Type Aliases

Classes

ReportType

ReportType:

Defines ReportType enum.

constructor

  • new ReportType(instanceProperties?: any): ReportType

  • initEnum() closes the class. Then calling this constructor throws an exception.

    If your subclass has a constructor then you can control what properties are added to this via the argument you pass to super(). No arguments are fine, too.

    Parameters

    • instanceProperties: any = ...

      Provides initial properties.

    Returns ReportType

optionalname

name?: string

ordinal

ordinal: any

staticCLASS

CLASS: default

staticCLASS_METHOD

CLASS_METHOD: any

staticMODULE

MODULE: default

staticMODULE_METHOD

MODULE_METHOD: any

staticNESTED_METHOD

NESTED_METHOD: ReportType

staticPROJECT

PROJECT: default

staticenumValues

enumValues: default[]

toString

  • toString(): string

  • Default toString() method for enum constant.

    Returns string

static[iterator]

  • [iterator](): IterableIterator<default>

  • Make enum classes iterable

    Returns IterableIterator<default>

staticenumValueOf

  • enumValueOf(name: string): default

  • Given the name of an enum constant, return its value.

    Parameters

    • name: string

      An enum name.

    Returns default

staticinitEnum

  • initEnum(arg: any): default

  • Set up the enum, close the class.

    Parameters

    • arg: any

      Either an object whose properties provide the names and values (which must be mutable objects) of the enum constants. Or an Array whose elements are used as the names of the enum constants. The values are create by instantiating the current class.

    Returns default

default

default:

Provides several helper methods to work with method oriented data stored as this.aggregate in ClassReport / ModuleReport and directly in ClassMethodReport / ModuleMethodReport.

constructor

  • new default(aggregateReport?: default): default

  • If given assigns the method report to an internal variable. This is used by ClassReport and ModuleReport which stores a AggregateReport respectively in this.aggregate. This is not set when AggregateReport uses this.

    Parameters

    • optionalaggregateReport: default

      An AggregateReport to associate with this report.

    Returns default

optionalaggregate

aggregate?: default

Stores any associated AggregateReport.

aggregateReport

  • get aggregateReport(): default

  • Returns the associated AggregateReport or this. Both ClassReport and ModuleReport have an aggregate AggregateReport.

    Returns default

toFormat

  • toFormat(name: string, options?: any): string

  • Formats this report given the type.

    Parameters

    • name: string

      The name of formatter to use.

    • options: any = ...

      (Optional) One or more optional parameters to pass to the formatter.

    Returns string

default

default:

Provides a wrapper around a data object hash which should contain an identifier field and potentially a filter field which is a function. The identifier can be a function or string or an array of functions / strings.

constructor

  • new default(metric: string, data: any): default

  • Initializes the Halstead trait.

    Parameters

    • metric: string

      The name of Halstead metric being stored.

    • data: any

      The data field to be wrapped.

    Returns default

metric

  • get metric(): string

  • Returns the associated metric type.

    Returns string

type

  • get type(): string

  • Returns the typeof data being wrapped.

    Returns string

filter

  • filter(...params: any): boolean

  • Returns the value of the filter field of the wrapped data. If the wrapped filter field is a function it is invoked with the given params otherwise the data is returned directly. If filter is not defined then true is returned.

    Parameters

    • rest...params: any

      Provides parameters which are forwarded onto any data stored as a function. Normally params should be the current AST node, parent AST node, ... optional data.

    Returns boolean

valueOf

  • valueOf(...params: any): any

  • Returns the value of the identifier field of the wrapped data. If the wrapped identifier field is a function it is invoked with the given params otherwise the data is returned directly.

    Parameters

    • rest...params: any

      Provides parameters which are forwarded onto any data stored as a function.

    Returns any

default

default:

Provides the class report object which stores data pertaining to a single ES6 class.

Methods that are stored as ClassMethodReport instances in the methods member variable.

constructor

  • new default(name?: string, superClassName?: string, lineStart?: number, lineEnd?: number): default

  • Initializes class report.

    Parameters

    • optionalname: string

      Name of the class.

    • optionalsuperClassName: string

      Name of any associated super class.

    • lineStart: number = 0

      Start line of class.

    • lineEnd: number = 0

      End line of class.

    Returns default

optionalaggregate

aggregate?: default

Stores any associated AggregateReport.

aggregateAverage

aggregateAverage: default

Stores the average class aggregate &amp; method metric data.

errors

errors: any[]

Stores any analysis errors.

lineEnd

lineEnd: number

Stores the end line for the class.

lineStart

lineStart: number

Stores the start line for the class.

methodAverage

methodAverage: default

Stores the average method metric data.

methods

methods: default[]

Stores all method data.

name

name: string

The name of the class.

superClassName

superClassName: string

The name of any associated super class.

aggregateReport

  • get aggregateReport(): default

  • Returns the associated AggregateReport or this. Both ClassReport and ModuleReport have an aggregate AggregateReport.

    Returns default

type

  • get type(): default

  • Returns the enum for the report type.

    Returns default

clearErrors

  • clearErrors(clearChildren?: boolean): void

  • Clears all errors stored in the class report and by default any class methods.

    Parameters

    • clearChildren: boolean = true

      (Optional) If false then class method errors are not cleared; default (true).

    Returns void

getErrors

  • getErrors(options?: { includeChildren: boolean; includeReports: boolean; query?: any }): (default | { error: default; source: string })[]

  • Gets all errors stored in the class report and by default any class methods.

    Parameters

    • options: { includeChildren: boolean; includeReports: boolean; query?: any } = ...

      Optional parameters.

    Returns (default | { error: default; source: string })[]

getName

  • getName(): string

  • Returns the name / id associated with this report.

    Returns string

toFormat

  • toFormat(name: string, options?: any): string

  • Formats this report given the type.

    Parameters

    • name: string

      The name of formatter to use.

    • options: any = ...

      (Optional) One or more optional parameters to pass to the formatter.

    Returns string

staticgetFormats

  • getFormats(): string[]

  • Returns the supported transform formats.

    Returns string[]

staticparse

  • parse(object: any): default

  • Deserializes a JSON object representing a ClassReport.

    Parameters

    • object: any

      A JSON object of a ClassReport that was previously serialized.

    Returns default

default

default:

Provides the class method report object which stores data pertaining to a single method / function.

constructor

  • new default(name?: string, paramNames?: string[], lineStart?: number, lineEnd?: number): default

  • Initializes class module method report.

    Parameters

    • optionalname: string

      Name of the method.

    • optionalparamNames: string[]

      Array of any associated parameter names.

    • optionallineStart: number

      Start line of method.

    • optionallineEnd: number

      End line of method.

    Returns default

optionalaggregate

aggregate?: default

Stores any associated AggregateReport.

cyclomatic

cyclomatic: number

The cyclomatic complexity of the method / report.

cyclomaticDensity

cyclomaticDensity: number

The cyclomatic density of the method.

errors

errors: any[]

Stores any analysis errors.

halstead

halstead: default

Stores the Halstead data instance.

lineEnd

lineEnd: number

Stores the end line for the method.

lineStart

lineStart: number

Stores the start line for the method.

maxNestedMethodDepth

maxNestedMethodDepth: number = 0

Stores the max nested method depth.

name

name: string

The name of the method.

optionalnestedMethods

nestedMethods?: any[]

paramCount

paramCount: number

The number of parameters for the method or aggregate report.

paramNames

paramNames: string[]

Stores any parameter names.

sloc

sloc: SLOC

The source lines of code for the method.

aggregateReport

  • get aggregateReport(): default

  • Returns the associated AggregateReport or this. Both ClassReport and ModuleReport have an aggregate AggregateReport.

    Returns default

type

  • get type(): any

  • Returns the enum for the report type.

    Returns any

clearErrors

  • clearErrors(clearChildren?: boolean): void

  • Clears all errors stored in the method report.

    Parameters

    • clearChildren: boolean = true

      (Optional) If false then nested method errors are not cleared; default (true).

    Returns void

getErrors

  • getErrors(options?: { includeChildren: boolean; includeReports: boolean; query?: any }): (default | { error: default; source: string })[]

  • Gets all errors stored in the method report and by default any nested methods.

    Parameters

    • options: { includeChildren: boolean; includeReports: boolean; query?: any } = ...

      Optional parameters.

    Returns (default | { error: default; source: string })[]

getName

  • getName(): string

  • Returns the name / id associated with this report.

    Returns string

toFormat

  • toFormat(name: string, options?: any): string

  • Formats this report given the type.

    Parameters

    • name: string

      The name of formatter to use.

    • options: any = ...

      (Optional) One or more optional parameters to pass to the formatter.

    Returns string

static_parse

  • _parse(targetObject: default | default, jsonObject: any): default | default

  • Deserializes a JSON object representing a ClassMethodReport.

    Parameters

    • targetObject: default | default

      A target object to hydrate.

    • jsonObject: any

      A JSON object of a class or module method report that was previously serialized.

    Returns default | default

staticgetFormats

  • getFormats(): any[]

  • Returns the supported transform formats.

    Returns any[]

staticparse

  • parse(object: any): default

  • Deserializes a JSON object representing a ClassMethodReport.

    Parameters

    • object: any

      A JSON object of a ClassMethodReport that was previously serialized.

    Returns default

default

default:

Provides the module method report object which stores data pertaining to a single method / function.

constructor

  • new default(name?: string, paramNames?: string[], lineStart?: number, lineEnd?: number): default

  • Initializes module method report.

    Parameters

    • optionalname: string

      Name of the method.

    • optionalparamNames: string[]

      Array of any associated parameter names.

    • optionallineStart: number

      Start line of method.

    • optionallineEnd: number

      End line of method.

    Returns default

optionalaggregate

aggregate?: default

Stores any associated AggregateReport.

cyclomatic

cyclomatic: number

The cyclomatic complexity of the method / report.

cyclomaticDensity

cyclomaticDensity: number

The cyclomatic density of the method.

errors

errors: any[]

Stores any analysis errors.

halstead

halstead: default

Stores the Halstead data instance.

lineEnd

lineEnd: number

Stores the end line for the method.

lineStart

lineStart: number

Stores the start line for the method.

maxNestedMethodDepth

maxNestedMethodDepth: number

Stores the max nested method depth.

name

name: string

The name of the method.

optionalnestedMethods

nestedMethods?: any[]

paramCount

paramCount: number

The number of parameters for the method or aggregate report.

paramNames

paramNames: string[]

Stores any parameter names.

sloc

sloc: SLOC

The source lines of code for the method.

aggregateReport

  • get aggregateReport(): default

  • Returns the associated AggregateReport or this. Both ClassReport and ModuleReport have an aggregate AggregateReport.

    Returns default

type

  • get type(): default

  • Returns the enum for the report type.

    Returns default

clearErrors

  • clearErrors(clearChildren?: boolean): void

  • Clears all errors stored in the method report.

    Parameters

    • clearChildren: boolean = true

      (Optional) If false then nested method errors are not cleared; default (true).

    Returns void

getErrors

  • getErrors(options?: { includeChildren: boolean; includeReports: boolean; query?: any }): (default | { error: default; source: string })[]

  • Gets all errors stored in the method report and by default any nested methods.

    Parameters

    • options: { includeChildren: boolean; includeReports: boolean; query?: any } = ...

      Optional parameters.

    Returns (default | { error: default; source: string })[]

getName

  • getName(): string

  • Returns the name / id associated with this report.

    Returns string

toFormat

  • toFormat(name: string, options?: any): string

  • Formats this report given the type.

    Parameters

    • name: string

      The name of formatter to use.

    • options: any = ...

      (Optional) One or more optional parameters to pass to the formatter.

    Returns string

static_parse

  • _parse(targetObject: default | default, jsonObject: any): default | default

  • Deserializes a JSON object representing a ClassMethodReport.

    Parameters

    • targetObject: default | default

      A target object to hydrate.

    • jsonObject: any

      A JSON object of a class or module method report that was previously serialized.

    Returns default | default

staticgetFormats

  • getFormats(): string[]

  • Returns the supported transform formats.

    Returns string[]

staticparse

  • parse(object: any): default

  • Deserializes a JSON object representing a ModuleMethodReport.

    Parameters

    • object: any

      A JSON object of a ModuleMethodReport that was previously serialized.

    Returns default

default

default:

Provides all the averaged module metric data.

constructor

  • new default(): default

  • Initializes the default averaged module data.

    Returns default

maintainability

maintainability: number

Measures the average method maintainability index for the module / file.

methodAverage

methodAverage: default

keys

  • get keys(): string[]

  • Returns the object accessor list / keys for ModuleAverage.

    Returns string[]

default

default:

Provides all the averaged method metric data.

constructor

  • new default(): default

  • Returns default

cyclomatic

cyclomatic: number

Measures the average method cyclomatic complexity of the module / class.

cyclomaticDensity

cyclomaticDensity: number

Measures the average method cyclomatic density of the module / class.

halstead

halstead: default

Stores the averaged Halstead metric data.

paramCount

paramCount: number

Measures the average number of method parameters for the module / class.

sloc

sloc: { logical: number; physical: number }

Measures the average source lines of code for the module / class.

Type declaration

  • logical: number
  • physical: number

keys

  • get keys(): string[]

  • Returns the object accessor list / keys for MethodAverage.

    Returns string[]

default

default:

Provides the aggregate report object which stores base data pertaining to a single method / function or cumulative aggregate data for a ModuleReport / ClassReport.

constructor

  • new default(lineStart?: number, lineEnd?: number, baseCyclomatic?: number): default

  • Initializes aggregate report.

    Parameters

    • lineStart: number = 0

      Start line of method.

    • lineEnd: number = 0

      End line of method.

    • baseCyclomatic: number = 1

      The initial base cyclomatic complexity of the report. Module and class reports start at 0.

    Returns default

optionalaggregate

aggregate?: default

Stores any associated AggregateReport.

cyclomatic

cyclomatic: number

The cyclomatic complexity of the method / report.

cyclomaticDensity

cyclomaticDensity: number

The cyclomatic density of the method.

halstead

halstead: default

Stores the Halstead data instance.

paramCount

paramCount: number

The number of parameters for the method or aggregate report.

sloc

sloc: SLOC

The source lines of code for the method.

aggregateReport

  • get aggregateReport(): default

  • Returns the associated AggregateReport or this. Both ClassReport and ModuleReport have an aggregate AggregateReport.

    Returns default

toFormat

  • toFormat(name: string, options?: any): string

  • Formats this report given the type.

    Parameters

    • name: string

      The name of formatter to use.

    • options: any = ...

      (Optional) One or more optional parameters to pass to the formatter.

    Returns string

default

default:

Defines the output data from parsing an AST tree.

constructor

  • new default(): default

  • Initializes ASTData

    Returns default

operands

operands: any[]

operators

operators: any[]

source

source: string

toString

  • toString(): string

  • Convert to string

    Returns string

write

  • write(string: string): void

  • Appends a string.

    Parameters

    • string: string

      A string to append.

    Returns void

default

default:

This is an abstract class that is not intended to be used directly. Extend it to turn your class into an enum (initialization is performed via MyClass.initEnum()).

Modified from source provided by enumify (license unlisted / public domain)

@see

https://github.com/rauschma/enumify

constructor

  • new default(instanceProperties?: any): default

  • initEnum() closes the class. Then calling this constructor throws an exception.

    If your subclass has a constructor then you can control what properties are added to this via the argument you pass to super(). No arguments are fine, too.

    Parameters

    • instanceProperties: any = ...

      Provides initial properties.

    Returns default

optionalname

name?: string

ordinal

ordinal: any

staticenumValues

enumValues: default[]

toString

  • toString(): string

  • Default toString() method for enum constant.

    Returns string

static[iterator]

  • [iterator](): IterableIterator<default>

  • Make enum classes iterable

    Returns IterableIterator<default>

staticenumValueOf

  • enumValueOf(name: string): default

  • Given the name of an enum constant, return its value.

    Parameters

    • name: string

      An enum name.

    Returns default

staticinitEnum

  • initEnum(arg: any): default

  • Set up the enum, close the class.

    Parameters

    • arg: any

      Either an object whose properties provide the names and values (which must be mutable objects) of the enum constants. Or an Array whose elements are used as the names of the enum constants. The values are create by instantiating the current class.

    Returns default

default

default:

Provides a wrapper for analysis errors stored in the errors array for each report type.

constructor

  • new default(severity?: string, message?: string, sourceReport?: default | default | default | default | default): default

  • Initializes an instance.

    Parameters

    • severity: string = "<unknown>"

      Provides the severity level.

    • message: string = ""

      Provides the error message.

    • sourceReport: default | default | default | default | default = ...

      The source report of the error.

    Returns default

lineEnd

lineEnd: number

Provides the line number where the error starts.

lineStart

lineStart: number

Provides the line number where the error starts.

message

message: string

Provides the error message.

name

name: string

Attempt to find the name then try srcPath for modules.

severity

severity: string

Provides the severity level.

type

type: any

Provides a type of report where the error is found.

toString

  • toString(): string

  • Returns a verbose string about the error.

    Returns string

staticparse

  • parse(object: any): default

  • Deserializes a JSON object representing a AnalyzeError.

    Parameters

    • object: any

      A JSON object of a AnalyzeError that was previously serialized.

    Returns default

default

default:

Provides a wrapper around a data field which may be an array, function or other primitive value.

constructor

  • new default(metric: string, data: any): default

  • Initializes trait data.

    Parameters

    • metric: string

      The name of Halstead metric being stored.

    • data: any

      Data to wrap.

    Returns default

metric

  • get metric(): string

  • Returns the associated metric type.

    Returns string

type

  • get type(): string | number | bigint | boolean | symbol | undefined | object | function

  • Returns the typeof data being wrapped.

    Returns string | number | bigint | boolean | symbol | undefined | object | function

valueOf

  • valueOf(...params: any[]): any

  • Returns the value of the given data. If the wrapped data is a function it is invoked with the given params otherwise the data is returned directly. If the wrapped data is an array a mapped version is returned with each entry that is a function being invoked with the given params.

    Parameters

    • rest...params: any[]

      Provides parameters which are forwarded onto any data stored as a function. Normally params should be the current AST node, parent AST node, ... optional data.

    Returns any

default

default:

Provides the data / event passed to all invoked methods in PluginManager#invokeSyncEvent. The event.data field is returned to the caller. Before returning though additional the following additional metadata is attached:

(number) $$plugin_invoke_count - The count of plugins invoked.

(Array

<string>
) $$plugin_invoke_names - The names of plugins invoked.

constructor

  • new default(copyProps?: {}, passthruProps?: {}, extraEventData?: any): default

  • Initializes PluginEvent.

    Parameters

    • optionalcopyProps: {}

      Event data to copy.

    • optionalpassthruProps: {}

      Event data to pass through.

    • optionalextraEventData: any

      Extra event data attached to extra.

    Returns default

data

data: any

Provides the unified event data assigning any pass through data to the copied data supplied.

eventbus

eventbus: EventEmitter

The active EventProxy for that particular plugin.

extra

extra: any

Stores any extra event data added to all PluginEvents.

ignoreKeys

ignoreKeys: any

list of keys to ignore

pluginName

pluginName: string

The active plugin name.

pluginOptions

pluginOptions: any

The active plugin options.

projectReport

projectReport: default

TODO: i don’t know where this is set, but it is used in excomplex-project/plugins

settings

settings: any

settings for the plugin instance

syntaxes

syntaxes: any

All loaded trait syntaxes for AST nodes

default

default:

Provides the method report object which stores data pertaining to a single method / function.

constructor

  • new default(name?: string, paramNames?: string[], lineStart?: number, lineEnd?: number): default

  • Initializes method report.

    Parameters

    • name: string = ""

      Name of the method.

    • paramNames: string[] = []

      Array of any associated parameter names.

    • lineStart: number = 0

      Start line of method.

    • lineEnd: number = 0

      End line of method.

    Returns default

optionalaggregate

aggregate?: default

Stores any associated AggregateReport.

cyclomatic

cyclomatic: number

The cyclomatic complexity of the method / report.

cyclomaticDensity

cyclomaticDensity: number

The cyclomatic density of the method.

errors

errors: any[]

Stores any analysis errors.

halstead

halstead: default

Stores the Halstead data instance.

lineEnd

lineEnd: number

Stores the end line for the method.

lineStart

lineStart: number

Stores the start line for the method.

name

name: string

The name of the method.

optionalnestedMethods

nestedMethods?: any[]

paramCount

paramCount: number

The number of parameters for the method or aggregate report.

paramNames

paramNames: string[]

Stores any parameter names.

sloc

sloc: SLOC

The source lines of code for the method.

aggregateReport

  • get aggregateReport(): default

  • Returns the associated AggregateReport or this. Both ClassReport and ModuleReport have an aggregate AggregateReport.

    Returns default

clearErrors

  • clearErrors(clearChildren?: boolean): void

  • Clears all errors stored in the method report.

    Parameters

    • clearChildren: boolean = true

      (Optional) If false then nested method errors are not cleared; default (true).

    Returns void

getErrors

  • getErrors(options?: { includeChildren: boolean; includeReports: boolean; query?: any }): (default | { error: default; source: string })[]

  • Gets all errors stored in the method report and by default any nested methods.

    Parameters

    • options: { includeChildren: boolean; includeReports: boolean; query?: any } = ...

      Optional parameters.

    Returns (default | { error: default; source: string })[]

getName

  • getName(): string

  • Returns the name / id associated with this report.

    Returns string

toFormat

  • toFormat(name: string, options?: any): string

  • Formats this report given the type.

    Parameters

    • name: string

      The name of formatter to use.

    • options: any = ...

      (Optional) One or more optional parameters to pass to the formatter.

    Returns string

static_parse

  • _parse(targetObject: default | default, jsonObject: any): default | default

  • Deserializes a JSON object representing a ClassMethodReport.

    Parameters

    • targetObject: default | default

      A target object to hydrate.

    • jsonObject: any

      A JSON object of a class or module method report that was previously serialized.

    Returns default | default

default

default:

Provides all Halstead metric data / parameters.

@see

https://en.wikipedia.org/wiki/Halstead_complexity_measures

constructor

  • new default(): default

  • Initializes the default Halstead data.

    Returns default

bugs

bugs: number

Measures an estimate for the number of potential errors.

difficulty

difficulty: number

Measures the difficulty of the program to write or understand.

effort

effort: number

Measures the maintenance effort of the program.

length

length: number

Defines the number of operands and operators.

operands

operands: { distinct: number; identifiers: never[]; total: number }

In general an operand participates in actions associated with operators. A distinct and total count is provided with all identifiers.

Type declaration

  • distinct: number
  • identifiers: never[]
  • total: number

operators

operators: { distinct: number; identifiers: never[]; total: number }

In general an operator carries out an action. A distinct and total count is provided with all identifiers.

Type declaration

  • distinct: number
  • identifiers: never[]
  • total: number

time

time: number

Measures potential coding time.

vocabulary

vocabulary: number

Defines the unique number of operands and operators.

volume

volume: number

Measures how much information a reader of the code potential has to absorb to understand its meaning.

reset

  • reset(clearIdentifiers?: boolean): default

  • Resets the state of all Halstead data metrics without removing any operand or operator data.

    Parameters

    • clearIdentifiers: boolean = false

      Clears operands / operators; default: false.

    Returns default

default

default:

Provides all the averaged Halstead metric data.

@see

https://en.wikipedia.org/wiki/Halstead_complexity_measures

constructor

  • new default(): default

  • Initializes the default Halstead data.

    Returns default

bugs

bugs: number

Measures an estimate for the number of potential errors.

difficulty

difficulty: number

Measures the difficulty of the program to write or understand.

effort

effort: number

Measures the maintenance effort of the program.

length

length: number

Defines the number of operands and operators.

operands

operands: { distinct: number; total: number }

In general an operand participates in actions associated with operators. A distinct and total count of identifiers.

Type declaration

  • distinct: number
  • total: number

operators

operators: { distinct: number; total: number }

In general an operator carries out an action. A distinct and total count of identifiers.

Type declaration

  • distinct: number
  • total: number

time

time: number

Measures potential coding time.

vocabulary

vocabulary: number

Defines the unique number of operands and operators.

volume

volume: number

Measures how much information a reader of the code potential has to absorb to understand its meaning.

default

default:

Provides the default project report object which stores data pertaining to all modules / files contained.

All modules are stored in the modules member variable as ModuleReports.

Various helper methods found in ModuleReport and AbstractReport help increment associated data during collection.

constructor

  • new default(moduleReports?: default[], settings?: { serializeModules: boolean } & {}): default

  • Initializes ProjectReport with default values.

    Parameters

    • optionalmoduleReports: default[]

      An array of ModuleReports for each module / file processed.

    • optionalsettings: { serializeModules: boolean } & {}

      An object hash of the settings used in generating this report via ESComplexProject.

    Returns default

adjacencyList

adjacencyList: number[][]

Stores a compacted form of the adjacency matrix. Each row index corresponds to the same report index. Each row entry corresponds to a report index. These relationships dictate the dependencies between all report ModuleReports given the source paths.

changeCost

changeCost: number

Measures the average percentage of modules affected when one module / file in the project is changed. Lower is better.

coreSize

coreSize: number

Measures the percentage of modules that are widely depended on which also depend on other modules. Lower is better.

errors

errors: any[]

Stores any analysis errors.

firstOrderDensity

firstOrderDensity: number

Measures the percentage of all possible internal dependencies that are actually realized in the project. Lower is better.

moduleAverage

moduleAverage: default

Stores the average module metric data.

modules

modules: any[] | default[]

Stores all ModuleReport data for the project sorted by the module / files srcPath.

settings

settings: { serializeModules: boolean } & {}

Stores the settings used to generate the project report.

visibilityList

visibilityList: number[][]

Stores a compacted form of the visibility matrix. Each row index corresponds to the same report index. Each row entry corresponds to a report index. These relationships dictate the reverse visibility between all report ModuleReports which may indirectly impact the given module / file.

type

  • get type(): default

  • Returns the enum for the report type.

    Returns default

clearErrors

  • clearErrors(clearChildren?: boolean): void

  • Clears all errors stored in the project report and by default any module reports.

    Parameters

    • optionalclearChildren: boolean

      (Optional) If false then class and module method errors are not cleared; default (true).

    Returns void

finalize

  • finalize(options?: { serializeModules: boolean }): default

  • Finalizes the ProjectReport. If settings.serializeModules is false output just filePath, srcPath &amp; srcPathAlias entries of modules.

    Parameters

    • optionaloptions: { serializeModules: boolean }

      (Optional) Allows overriding of ModuleReport serialization.

    Returns default

getErrors

  • getErrors(options?: { includeChildren: boolean; includeReports: boolean; query?: any }): (default | { error: default; source: string })[]

  • Gets all errors stored in the project report and by default any module reports.

    Parameters

    • optionaloptions: { includeChildren: boolean; includeReports: boolean; query?: any }

      Optional parameters.

    Returns (default | { error: default; source: string })[]

getName

  • getName(): any

  • Returns the name / id associated with this report.

    Returns any

getSetting

  • getSetting(key: string, defaultValue?: any): any

  • Returns the setting indexed by the given key.

    Parameters

    • key: string

      A key used to store the setting parameter.

    • optionaldefaultValue: any

      A default value to return if no setting for the given key is currently stored.

    Returns any

setSetting

  • setSetting(key: string, value: any): boolean

  • Sets the setting indexed by the given key and returns true if successful.

    Parameters

    • key: string

      A key used to store the setting parameter.

    • value: any

      A value to set to this.settings[key].

    Returns boolean

toFormat

  • toFormat(name: string, options?: any): string

  • Formats this ProjectReport given the type.

    Parameters

    • name: string

      The name of formatter to use.

    • optionaloptions: any

      (Optional) One or more optional parameters to pass to the formatter.

    Returns string

staticgetFormats

  • getFormats(): string[]

  • Returns the supported transform formats.

    Returns string[]

staticparse

  • parse(object: any, options?: { skipFinalize: boolean }): default

  • Deserializes a JSON object representing a ProjectReport.

    Parameters

    • object: any

      A JSON object of a ProjectReport that was previously serialized.

    • optionaloptions: { skipFinalize: boolean }

      Optional parameters.

    Returns default

default

default:

Provides all the averaged module metric data.

constructor

  • new default(): default

  • Initializes the default averaged module data.

    Returns default

maintainability

maintainability: number

Measures the average method maintainability index for the module / file.

methodAverage

methodAverage: default

keys

  • get keys(): string[]

  • Returns the object accessor list / keys for ModuleAverage.

    Returns string[]

default

default:

Provides the module report object which stores data pertaining to a single file / module being processed.

All ES Module classes are stored in the classes member variable as ClassReports. Methods that are not part of a class are stored as ModuleMethodReport instances in the methods member variable.

Various helper methods found in ModuleReport and AbstractReport help increment associated data during collection.

constructor

  • new default(lineStart?: number, lineEnd?: number, settings?: any): default

  • Initializes the report.

    Parameters

    • optionallineStart: number

      Start line of file / module.

    • optionallineEnd: number

      End line of file / module.

    • optionalsettings: any

      An object hash of the settings used in generating this report via ESComplexModule.

    Returns default

optionalaggregate

aggregate?: default

Stores any associated AggregateReport.

aggregateAverage

aggregateAverage: default

Stores the average module / class aggregate &amp; method metric data.

classes

classes: default[]

Stores all ClassReport data for the module.

dependencies

dependencies: never[]

Stores all parsed dependencies.

errors

errors: never[]

Stores any analysis errors.

filePath

filePath: string

Stores the file path of the module / file. The file path is only defined as supplied when processing projects.

lineEnd

lineEnd: number

Stores the end line for the module / file.

lineStart

lineStart: number

Stores the start line for the module / file.

maintainability

maintainability: number

Measures the average maintainability index for the module / file.

methodAverage

methodAverage: default

Stores just the average method metric data.

methods

methods: default[]

Stores all module ModuleMethodReport data found outside of any ES6 classes.

settings

settings: any

Stores the settings used to generate the module report.

srcPath

srcPath: string

Stores the active source path of the module / file. This path is respective of how the file is referenced in the source code itself. srcPath is only defined as supplied when processing projects.

srcPathAlias

srcPathAlias: string

Stores the active source path alias of the module / file. This path is respective of how the file is referenced in the source code itself when aliased including NPM and JSPM modules which provide a main entry. srcPathAlias is only defined as supplied when processing projects.

aggregateReport

  • get aggregateReport(): default

  • Returns the associated AggregateReport or this. Both ClassReport and ModuleReport have an aggregate AggregateReport.

    Returns default

type

  • get type(): default

  • Returns the enum for the report type.

    Returns default

clearErrors

  • clearErrors(clearChildren?: boolean): void

  • Clears all errors stored in the module report and by default any class reports and module methods.

    Parameters

    • optionalclearChildren: boolean

      (Optional) If false then class and module method errors are not cleared; default (true).

    Returns void

finalize

  • finalize(): default

  • Cleans up any house keeping member variables.

    Returns default

getErrors

  • getErrors(options?: { includeChildren: boolean; includeReports: boolean; query?: any }): (default | { error: default; source: string })[]

  • Gets all errors stored in the module report and by default any module methods and class reports.

    Parameters

    • optionaloptions: { includeChildren: boolean; includeReports: boolean; query?: any }

      Optional parameters.

    Returns (default | { error: default; source: string })[]

getName

  • getName(): string

  • Returns the name / id associated with this report.

    Returns string

getSetting

  • getSetting(key: string, defaultValue?: any): any

  • Returns the setting indexed by the given key.

    Parameters

    • key: string

      A key used to store the setting parameter.

    • optionaldefaultValue: any

      A default value to return if no setting for the given key is currently stored.

    Returns any

setSetting

  • setSetting(key: string, value: any): boolean

  • Sets the setting indexed by the given key and returns true if successful.

    Parameters

    • key: string

      A key used to store the setting parameter.

    • value: any

      A value to set to this.settings[key].

    Returns boolean

toFormat

  • toFormat(name: string, options?: any): string

  • Formats this report given the type.

    Parameters

    • name: string

      The name of formatter to use.

    • optionaloptions: any

      (Optional) One or more optional parameters to pass to the formatter.

    Returns string

staticgetFormats

  • getFormats(): string[]

  • Returns the supported transform formats.

    Returns string[]

staticparse

  • parse(object: any): default

  • Deserializes a JSON object representing a ModuleReport.

    Parameters

    • object: any

      A JSON object of a ModuleReport that was previously serialized.

    Returns default

default

default:

This is an abstract class that is not intended to be used directly. Extend it to turn your class into an enum (initialization is performed via MyClass.initEnum()).

Modified from source provided by enumify (license unlisted / public domain)

@see

https://github.com/rauschma/enumify

constructor

  • new default(instanceProperties?: any): default

  • initEnum() closes the class. Then calling this constructor throws an exception.

    If your subclass has a constructor then you can control what properties are added to this via the argument you pass to super(). No arguments are fine, too.

    Parameters

    • optionalinstanceProperties: any

      Provides initial properties.

    Returns default

optionalname

name?: string

ordinal

ordinal: any

staticenumValues

enumValues: default[]

toString

  • toString(): string

  • Default toString() method for enum constant.

    Returns string

static[iterator]

  • [iterator](): IterableIterator<default>

  • Make enum classes iterable

    Returns IterableIterator<default>

staticenumValueOf

  • enumValueOf(name: string): default

  • Given the name of an enum constant, return its value.

    Parameters

    • name: string

      An enum name.

    Returns default

staticinitEnum

  • initEnum(arg: any): default

  • Set up the enum, close the class.

    Parameters

    • arg: any

      Either an object whose properties provide the names and values (which must be mutable objects) of the enum constants. Or an Array whose elements are used as the names of the enum constants. The values are create by instantiating the current class.

    Returns default

default

default:

Provides a wrapper for analysis errors stored in the errors array for each report type.

constructor

  • new default(severity?: string, message?: string, sourceReport?: default | default | default | default | default): default

  • Initializes an instance.

    Parameters

    • optionalseverity: string

      Provides the severity level.

    • optionalmessage: string

      Provides the error message.

    • optionalsourceReport: default | default | default | default | default

      The source report of the error.

    Returns default

lineEnd

lineEnd: number

Provides the line number where the error starts.

lineStart

lineStart: number

Provides the line number where the error starts.

message

message: string

Provides the error message.

name

name: string

Attempt to find the name then try srcPath for modules.

severity

severity: string

Provides the severity level.

type

type: any

Provides a type of report where the error is found.

toString

  • toString(): string

  • Returns a verbose string about the error.

    Returns string

staticparse

  • parse(object: any): default

  • Deserializes a JSON object representing a AnalyzeError.

    Parameters

    • object: any

      A JSON object of a AnalyzeError that was previously serialized.

    Returns default

default

default:

Provides several helper methods to work with method oriented data stored as this.aggregate in ClassReport / ModuleReport and directly in ClassMethodReport / ModuleMethodReport.

constructor

  • new default(aggregateReport?: default): default

  • If given assigns the method report to an internal variable. This is used by ClassReport and ModuleReport which stores a AggregateReport respectively in this.aggregate. This is not set when AggregateReport uses this.

    Parameters

    • optionalaggregateReport: default

      An AggregateReport to associate with this report.

    Returns default

optionalaggregate

aggregate?: default

Stores any associated AggregateReport.

aggregateReport

  • get aggregateReport(): default

  • Returns the associated AggregateReport or this. Both ClassReport and ModuleReport have an aggregate AggregateReport.

    Returns default

toFormat

  • toFormat(name: string, options?: any): string

  • Formats this report given the type.

    Parameters

    • name: string

      The name of formatter to use.

    • optionaloptions: any

      (Optional) One or more optional parameters to pass to the formatter.

    Returns string

default

default:

Provides all the averaged method metric data.

constructor

  • new default(): default

  • Returns default

cyclomatic

cyclomatic: number

Measures the average method cyclomatic complexity of the module / class.

cyclomaticDensity

cyclomaticDensity: number

Measures the average method cyclomatic density of the module / class.

halstead

halstead: default

Stores the averaged Halstead metric data.

paramCount

paramCount: number

Measures the average number of method parameters for the module / class.

sloc

sloc: { logical: number; physical: number }

Measures the average source lines of code for the module / class.

Type declaration

  • logical: number
  • physical: number

keys

  • get keys(): string[]

  • Returns the object accessor list / keys for MethodAverage.

    Returns string[]

default

default:

Provides the class report object which stores data pertaining to a single ES6 class.

Methods that are stored as ClassMethodReport instances in the methods member variable.

constructor

  • new default(name?: string, superClassName?: string, lineStart?: number, lineEnd?: number): default

  • Initializes class report.

    Parameters

    • optionalname: string

      Name of the class.

    • optionalsuperClassName: string

      Name of any associated super class.

    • optionallineStart: number

      Start line of class.

    • optionallineEnd: number

      End line of class.

    Returns default

optionalaggregate

aggregate?: default

Stores any associated AggregateReport.

aggregateAverage

aggregateAverage: default

Stores the average class aggregate &amp; method metric data.

errors

errors: any[]

Stores any analysis errors.

lineEnd

lineEnd: number

Stores the end line for the class.

lineStart

lineStart: number

Stores the start line for the class.

methodAverage

methodAverage: default

Stores the average method metric data.

methods

methods: default[]

Stores all method data.

name

name: string

The name of the class.

superClassName

superClassName: string

The name of any associated super class.

aggregateReport

  • get aggregateReport(): default

  • Returns the associated AggregateReport or this. Both ClassReport and ModuleReport have an aggregate AggregateReport.

    Returns default

type

  • get type(): default

  • Returns the enum for the report type.

    Returns default

clearErrors

  • clearErrors(clearChildren?: boolean): void

  • Clears all errors stored in the class report and by default any class methods.

    Parameters

    • optionalclearChildren: boolean

      (Optional) If false then class method errors are not cleared; default (true).

    Returns void

getErrors

  • getErrors(options?: { includeChildren: boolean; includeReports: boolean; query?: any }): (default | { error: default; source: string })[]

  • Gets all errors stored in the class report and by default any class methods.

    Parameters

    • optionaloptions: { includeChildren: boolean; includeReports: boolean; query?: any }

      Optional parameters.

    Returns (default | { error: default; source: string })[]

getName

  • getName(): string

  • Returns the name / id associated with this report.

    Returns string

toFormat

  • toFormat(name: string, options?: any): string

  • Formats this report given the type.

    Parameters

    • name: string

      The name of formatter to use.

    • optionaloptions: any

      (Optional) One or more optional parameters to pass to the formatter.

    Returns string

staticgetFormats

  • getFormats(): string[]

  • Returns the supported transform formats.

    Returns string[]

staticparse

  • parse(object: any): default

  • Deserializes a JSON object representing a ClassReport.

    Parameters

    • object: any

      A JSON object of a ClassReport that was previously serialized.

    Returns default

default

default:

Provides the module method report object which stores data pertaining to a single method / function.

constructor

  • new default(name?: string, paramNames?: string[], lineStart?: number, lineEnd?: number): default

  • Initializes module method report.

    Parameters

    • optionalname: string

      Name of the method.

    • optionalparamNames: string[]

      Array of any associated parameter names.

    • optionallineStart: number

      Start line of method.

    • optionallineEnd: number

      End line of method.

    Returns default

optionalaggregate

aggregate?: default

Stores any associated AggregateReport.

cyclomatic

cyclomatic: number

The cyclomatic complexity of the method / report.

cyclomaticDensity

cyclomaticDensity: number

The cyclomatic density of the method.

errors

errors: any[]

Stores any analysis errors.

halstead

halstead: default

Stores the Halstead data instance.

lineEnd

lineEnd: number

Stores the end line for the method.

lineStart

lineStart: number

Stores the start line for the method.

maxNestedMethodDepth

maxNestedMethodDepth: number

Stores the max nested method depth.

name

name: string

The name of the method.

optionalnestedMethods

nestedMethods?: any[]

paramCount

paramCount: number

The number of parameters for the method or aggregate report.

paramNames

paramNames: string[]

Stores any parameter names.

sloc

sloc: SLOC

The source lines of code for the method.

aggregateReport

  • get aggregateReport(): default

  • Returns the associated AggregateReport or this. Both ClassReport and ModuleReport have an aggregate AggregateReport.

    Returns default

type

  • get type(): default

  • Returns the enum for the report type.

    Returns default

clearErrors

  • clearErrors(clearChildren?: boolean): void

  • Clears all errors stored in the method report.

    Parameters

    • optionalclearChildren: boolean

      (Optional) If false then nested method errors are not cleared; default (true).

    Returns void

getErrors

  • getErrors(options?: { includeChildren: boolean; includeReports: boolean; query?: any }): (default | { error: default; source: string })[]

  • Gets all errors stored in the method report and by default any nested methods.

    Parameters

    • optionaloptions: { includeChildren: boolean; includeReports: boolean; query?: any }

      Optional parameters.

    Returns (default | { error: default; source: string })[]

getName

  • getName(): string

  • Returns the name / id associated with this report.

    Returns string

toFormat

  • toFormat(name: string, options?: any): string

  • Formats this report given the type.

    Parameters

    • name: string

      The name of formatter to use.

    • optionaloptions: any

      (Optional) One or more optional parameters to pass to the formatter.

    Returns string

static_parse

  • _parse(targetObject: default | default, jsonObject: any): default | default

  • Deserializes a JSON object representing a ClassMethodReport.

    Parameters

    • targetObject: default | default

      A target object to hydrate.

    • jsonObject: any

      A JSON object of a class or module method report that was previously serialized.

    Returns default | default

staticgetFormats

  • getFormats(): string[]

  • Returns the supported transform formats.

    Returns string[]

staticparse

  • parse(object: any): default

  • Deserializes a JSON object representing a ModuleMethodReport.

    Parameters

    • object: any

      A JSON object of a ModuleMethodReport that was previously serialized.

    Returns default

default

default:

Provides the aggregate report object which stores base data pertaining to a single method / function or cumulative aggregate data for a ModuleReport / ClassReport.

constructor

  • new default(lineStart?: number, lineEnd?: number, baseCyclomatic?: number): default

  • Initializes aggregate report.

    Parameters

    • optionallineStart: number

      Start line of method.

    • optionallineEnd: number

      End line of method.

    • optionalbaseCyclomatic: number

      The initial base cyclomatic complexity of the report. Module and class reports start at 0.

    Returns default

optionalaggregate

aggregate?: default

Stores any associated AggregateReport.

cyclomatic

cyclomatic: number

The cyclomatic complexity of the method / report.

cyclomaticDensity

cyclomaticDensity: number

The cyclomatic density of the method.

halstead

halstead: default

Stores the Halstead data instance.

paramCount

paramCount: number

The number of parameters for the method or aggregate report.

sloc

sloc: SLOC

The source lines of code for the method.

aggregateReport

  • get aggregateReport(): default

  • Returns the associated AggregateReport or this. Both ClassReport and ModuleReport have an aggregate AggregateReport.

    Returns default

toFormat

  • toFormat(name: string, options?: any): string

  • Formats this report given the type.

    Parameters

    • name: string

      The name of formatter to use.

    • optionaloptions: any

      (Optional) One or more optional parameters to pass to the formatter.

    Returns string

default

default:

Provides the class method report object which stores data pertaining to a single method / function.

constructor

  • new default(name?: string, paramNames?: string[], lineStart?: number, lineEnd?: number): default

  • Initializes class module method report.

    Parameters

    • optionalname: string

      Name of the method.

    • optionalparamNames: string[]

      Array of any associated parameter names.

    • optionallineStart: number

      Start line of method.

    • optionallineEnd: number

      End line of method.

    Returns default

optionalaggregate

aggregate?: default

Stores any associated AggregateReport.

cyclomatic

cyclomatic: number

The cyclomatic complexity of the method / report.

cyclomaticDensity

cyclomaticDensity: number

The cyclomatic density of the method.

errors

errors: any[]

Stores any analysis errors.

halstead

halstead: default

Stores the Halstead data instance.

lineEnd

lineEnd: number

Stores the end line for the method.

lineStart

lineStart: number

Stores the start line for the method.

maxNestedMethodDepth

maxNestedMethodDepth: number

Stores the max nested method depth.

name

name: string

The name of the method.

optionalnestedMethods

nestedMethods?: any[]

paramCount

paramCount: number

The number of parameters for the method or aggregate report.

paramNames

paramNames: string[]

Stores any parameter names.

sloc

sloc: SLOC

The source lines of code for the method.

aggregateReport

  • get aggregateReport(): default

  • Returns the associated AggregateReport or this. Both ClassReport and ModuleReport have an aggregate AggregateReport.

    Returns default

type

  • get type(): any

  • Returns the enum for the report type.

    Returns any

clearErrors

  • clearErrors(clearChildren?: boolean): void

  • Clears all errors stored in the method report.

    Parameters

    • optionalclearChildren: boolean

      (Optional) If false then nested method errors are not cleared; default (true).

    Returns void

getErrors

  • getErrors(options?: { includeChildren: boolean; includeReports: boolean; query?: any }): (default | { error: default; source: string })[]

  • Gets all errors stored in the method report and by default any nested methods.

    Parameters

    • optionaloptions: { includeChildren: boolean; includeReports: boolean; query?: any }

      Optional parameters.

    Returns (default | { error: default; source: string })[]

getName

  • getName(): string

  • Returns the name / id associated with this report.

    Returns string

toFormat

  • toFormat(name: string, options?: any): string

  • Formats this report given the type.

    Parameters

    • name: string

      The name of formatter to use.

    • optionaloptions: any

      (Optional) One or more optional parameters to pass to the formatter.

    Returns string

static_parse

  • _parse(targetObject: default | default, jsonObject: any): default | default

  • Deserializes a JSON object representing a ClassMethodReport.

    Parameters

    • targetObject: default | default

      A target object to hydrate.

    • jsonObject: any

      A JSON object of a class or module method report that was previously serialized.

    Returns default | default

staticgetFormats

  • getFormats(): any[]

  • Returns the supported transform formats.

    Returns any[]

staticparse

  • parse(object: any): default

  • Deserializes a JSON object representing a ClassMethodReport.

    Parameters

    • object: any

      A JSON object of a ClassMethodReport that was previously serialized.

    Returns default

default

default:

Provides the method report object which stores data pertaining to a single method / function.

constructor

  • new default(name?: string, paramNames?: string[], lineStart?: number, lineEnd?: number): default

  • Initializes method report.

    Parameters

    • optionalname: string

      Name of the method.

    • optionalparamNames: string[]

      Array of any associated parameter names.

    • optionallineStart: number

      Start line of method.

    • optionallineEnd: number

      End line of method.

    Returns default

optionalaggregate

aggregate?: default

Stores any associated AggregateReport.

cyclomatic

cyclomatic: number

The cyclomatic complexity of the method / report.

cyclomaticDensity

cyclomaticDensity: number

The cyclomatic density of the method.

errors

errors: any[]

Stores any analysis errors.

halstead

halstead: default

Stores the Halstead data instance.

lineEnd

lineEnd: number

Stores the end line for the method.

lineStart

lineStart: number

Stores the start line for the method.

name

name: string

The name of the method.

optionalnestedMethods

nestedMethods?: any[]

paramCount

paramCount: number

The number of parameters for the method or aggregate report.

paramNames

paramNames: string[]

Stores any parameter names.

sloc

sloc: SLOC

The source lines of code for the method.

aggregateReport

  • get aggregateReport(): default

  • Returns the associated AggregateReport or this. Both ClassReport and ModuleReport have an aggregate AggregateReport.

    Returns default

clearErrors

  • clearErrors(clearChildren?: boolean): void

  • Clears all errors stored in the method report.

    Parameters

    • optionalclearChildren: boolean

      (Optional) If false then nested method errors are not cleared; default (true).

    Returns void

getErrors

  • getErrors(options?: { includeChildren: boolean; includeReports: boolean; query?: any }): (default | { error: default; source: string })[]

  • Gets all errors stored in the method report and by default any nested methods.

    Parameters

    • optionaloptions: { includeChildren: boolean; includeReports: boolean; query?: any }

      Optional parameters.

    Returns (default | { error: default; source: string })[]

getName

  • getName(): string

  • Returns the name / id associated with this report.

    Returns string

toFormat

  • toFormat(name: string, options?: any): string

  • Formats this report given the type.

    Parameters

    • name: string

      The name of formatter to use.

    • optionaloptions: any

      (Optional) One or more optional parameters to pass to the formatter.

    Returns string

static_parse

  • _parse(targetObject: default | default, jsonObject: any): default | default

  • Deserializes a JSON object representing a ClassMethodReport.

    Parameters

    • targetObject: default | default

      A target object to hydrate.

    • jsonObject: any

      A JSON object of a class or module method report that was previously serialized.

    Returns default | default

default

default:

Provides all the averaged Halstead metric data.

@see

https://en.wikipedia.org/wiki/Halstead_complexity_measures

constructor

  • new default(): default

  • Initializes the default Halstead data.

    Returns default

bugs

bugs: number

Measures an estimate for the number of potential errors.

difficulty

difficulty: number

Measures the difficulty of the program to write or understand.

effort

effort: number

Measures the maintenance effort of the program.

length

length: number

Defines the number of operands and operators.

operands

operands: { distinct: number; total: number }

In general an operand participates in actions associated with operators. A distinct and total count of identifiers.

Type declaration

  • distinct: number
  • total: number

operators

operators: { distinct: number; total: number }

In general an operator carries out an action. A distinct and total count of identifiers.

Type declaration

  • distinct: number
  • total: number

time

time: number

Measures potential coding time.

vocabulary

vocabulary: number

Defines the unique number of operands and operators.

volume

volume: number

Measures how much information a reader of the code potential has to absorb to understand its meaning.

default

default:

Provides all Halstead metric data / parameters.

@see

https://en.wikipedia.org/wiki/Halstead_complexity_measures

constructor

  • new default(): default

  • Initializes the default Halstead data.

    Returns default

bugs

bugs: number

Measures an estimate for the number of potential errors.

difficulty

difficulty: number

Measures the difficulty of the program to write or understand.

effort

effort: number

Measures the maintenance effort of the program.

length

length: number

Defines the number of operands and operators.

operands

operands: { distinct: number; identifiers: never[]; total: number }

In general an operand participates in actions associated with operators. A distinct and total count is provided with all identifiers.

Type declaration

  • distinct: number
  • identifiers: never[]
  • total: number

operators

operators: { distinct: number; identifiers: never[]; total: number }

In general an operator carries out an action. A distinct and total count is provided with all identifiers.

Type declaration

  • distinct: number
  • identifiers: never[]
  • total: number

time

time: number

Measures potential coding time.

vocabulary

vocabulary: number

Defines the unique number of operands and operators.

volume

volume: number

Measures how much information a reader of the code potential has to absorb to understand its meaning.

reset

  • reset(clearIdentifiers?: boolean): default

  • Resets the state of all Halstead data metrics without removing any operand or operator data.

    Parameters

    • optionalclearIdentifiers: boolean

      Clears operands / operators; default: false.

    Returns default

Type Aliases

SLOC

SLOC: { logical: number; physical: number }

Type declaration

  • logical: number
  • physical: number

SLOC

SLOC: { logical: number; physical: number }

Type declaration

  • logical: number
  • physical: number

ValidateArrayOptions

ValidateArrayOptions: { error?: boolean; expected?: any; message?: string; required?: boolean; type?: string }

Type declaration

  • optionalerror?: boolean
  • optionalexpected?: any
  • optionalmessage?: string
  • optionalrequired?: boolean
  • optionaltype?: string